Use minimum API version for bulk operations by nickwesselman · Pull Request #6697 · Shopify/cli

nickwesselman · 2025-12-09T17:17:21Z

WHY are these changes introduced?

This PR improves API version handling and error presentation in bulk operations to provide a more consistent and user-friendly experience.

WHAT is this pull request doing?

Introduces a minimum API version constant for bulk operations
Replaces hardcoded API version with dynamic version resolution
Improves error handling in bulk operations by:
- Changing from renderWarning to renderError to better reflect severity
- Formatting error messages as a structured list for better readability
- Removing unnecessary prefixes when no field is present
- Using a more descriptive headline ("Error creating bulk operation")
Adds a new resolveApiVersion function that intelligently selects the appropriate API version based on:
- User-provided version flag
- Minimum required version
- Latest supported version from the API
Adds comprehensive tests for the new version resolution logic

How to test your changes?

Run a bulk operation with intentional errors
Verify that error messages are displayed properly with the new format
Test with different API version flags to ensure proper version resolution
Confirm that operations use the minimum required version when appropriate

Measuring impact

How do we know this change was effective? Please choose one:

n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix
Existing analytics will cater for this addition
PR includes analytics changes to measure impact

Checklist

I've considered possible cross-platform impacts (Mac, Linux, Windows)
I've considered possible documentation changes

nickwesselman · 2025-12-09T17:17:46Z

This stack of pull requests is managed by Graphite. Learn more about stacking.

github-actions · 2025-12-09T17:18:03Z

We detected some changes at packages/*/src and there are no updates in the .changeset.
If the changes are user-facing, run pnpm changeset add to track your changes and include them in the next release CHANGELOG.

Caution

DO NOT create changesets for features which you do not wish to be included in the public changelog of the next CLI release.

github-actions · 2025-12-09T17:23:38Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	79.5% (+0.27% 🔼)	14174/17829
🟡	Branches	73.54% (+0.44% 🔼)	6950/9450
🟡	Functions	79.66% (+0.29% 🔼)	3638/4567
🟡	Lines	79.87% (+0.29% 🔼)	13399/16776

Show new covered files 🐣

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / admin-as-app.ts	100%	100%	100%	100%
🟢	`...` / metafield_definitions.ts	100%	100%	100%	100%
🟢	`...` / metaobject_definitions.ts	100%	100%	100%	100%
🟢	`...` / bulk-operation-run-mutation.ts	100%	100%	100%	100%
🟢	`...` / bulk-operation-run-query.ts	100%	100%	100%	100%
🟢	`...` / get-bulk-operation-by-id.ts	100%	100%	100%	100%
🟢	`...` / list-bulk-operations.ts	100%	100%	100%	100%
🟢	`...` / staged-uploads-create.ts	100%	100%	100%	100%
🔴	`...` / execute.ts	0%	0%	0%	0%
🔴	`...` / status.ts	0%	0%	0%	0%
🔴	`...` / pull.ts	0%	100%	0%	0%
🟢	`...` / execute-operation.ts	92.59%	75%	100%	92.31%
🔴	`...` / pull.ts	0%	0%	0%	0%
🟢	`...` / bulk-operation-status.ts	96.55%	92.11%	100%	100%
🟢	`...` / constants.ts	100%	100%	100%	100%
🟢	`...` / download-bulk-operation-results.ts	100%	100%	100%	100%
🟢	`...` / execute-bulk-operation.ts	92.65%	86.67%	100%	93.94%
🟢	`...` / format-bulk-operation-status.ts	100%	100%	100%	100%
🟢	`...` / run-mutation.ts	100%	100%	100%	100%
🟢	`...` / run-query.ts	100%	100%	100%	100%
🟡	`...` / stage-file.ts	73.53%	62.5%	85.71%	72.73%
🟢	`...` / watch-bulk-operation.ts	100%	94.74%	100%	100%
🟢	`...` / declarative-definitions.ts	98.54%	93.18%	100%	98.51%
🟢	`...` / common.ts	97.22%	93.75%	100%	96.55%
🟢	`...` / execute-command-helpers.ts	100%	100%	100%	100%
🔴	`...` / promiseWithResolvers.ts	33.33%	50%	50%	33.33%

Show files with reduced coverage 🔻

St.^❔	File	Statements	Branches	Functions	Lines
🔴	`...` / execute.ts	0%	0% (-100% 🔻)	0%	0%
🟢	`...` / extension-instance.ts	84.8% (+0.23% 🔼)	77.6% (-0.91% 🔻)	92.06% (+0.13% 🔼)	85.11% (+0.24% 🔼)
🟡	`...` / specification.ts	69.09%	75.61% (+2.44% 🔼)	76.47% (-1.31% 🔻)	68.75%
🟢	`...` / ui_extension.ts	85.38% (-9.44% 🔻)	72.34% (-8.91% 🔻)	84% (-16% 🔻)	88% (-8.46% 🔻)
🟢	`...` / developer-platform-client.ts	84.62% (-1.5% 🔻)	71.43% (+0.84% 🔼)	81.82% (+1.82% 🔼)	93.75% (+0.42% 🔼)
🟢	`...` / api.ts	87.07% (-0.43% 🔻)	76.71% (-0.1% 🔻)	100%	86.49% (-0.43% 🔻)
🟢	`...` / ConcurrentOutput.tsx	98.36% (-1.64% 🔻)	92% (-4% 🔻)	100%	98.33% (-1.67% 🔻)
🟢	`...` / SingleTask.tsx	84.21% (-15.79% 🔻)	50% (-50% 🔻)	80% (-20% 🔻)	84.21% (-15.79% 🔻)
🔴	`...` / environment.ts	35% (-5% 🔻)	41.18%	40% (-10% 🔻)	36.84% (-5.26% 🔻)
🔴	`...` / ui.tsx	50.82% (-0.79% 🔻)	42.86% (-5.53% 🔻)	54.55% (+1.42% 🔼)	50% (-0.82% 🔻)
🟢	`...` / console.ts	81.82% (+15.15% 🔼)	75% (-25% 🔻)	100% (+33.33% 🔼)	81.82% (+15.15% 🔼)
🔴	`...` / dev.ts	14.29% (+0.95% 🔼)	3.13% (+0.18% 🔼)	50% (-7.14% 🔻)	14.29% (+0.95% 🔼)
🟢	`...` / init.ts	88% (-0.89% 🔻)	71.43% (+4.76% 🔼)	86.67% (+4.85% 🔼)	88% (-0.89% 🔻)
🟢	`...` / storefront-renderer.ts	90.2% (-0.54% 🔻)	78.95%	81.82% (-1.52% 🔻)	90.2% (-0.54% 🔻)
🟡	`...` / theme-polling.ts	67.12% (-0.93% 🔻)	68.75%	78.57%	66.67% (-0.98% 🔻)

Test suite run success

3553 tests passing in 1415 suites.

Report generated by 🧪jest coverage report action from a96993e

packages/app/src/cli/services/bulk-operations/bulk-operation-status.test.ts

jordanverasamy

thank you for putting this together <3

nickwesselman · 2025-12-09T20:44:22Z

/snapit

packages/app/src/cli/services/bulk-operations/execute-bulk-operation.test.ts

nickwesselman · 2025-12-09T23:45:39Z

/snapit

gonzaloriestra · 2025-12-10T09:45:24Z

/snapit

gonzaloriestra · 2025-12-10T09:50:49Z

/snapit

gonzaloriestra · 2025-12-11T13:23:51Z

/snapit

gonzaloriestra · 2025-12-12T11:58:57Z

/snapit

packages/app/src/cli/services/graphql/common.ts

…ulk operations

nickwesselman · 2025-12-12T20:18:13Z

/snapit

github-actions · 2025-12-12T20:46:17Z

Differences in type declarations

We detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:

Some seemingly private modules might be re-exported through public modules.
If the branch is behind main you might see odd diffs, rebase main into this branch.

New type declarations

We found no new type declarations in this PR

Existing type declarations

packages/cli-kit/dist/public/node/api/admin.d.ts

@@ -41,6 +41,14 @@ export declare function adminRequestDoc<TResult, TVariables extends Variables>(o
  * @returns - An array of supported API versions.
  */
 export declare function supportedApiVersions(session: AdminSession, preferredBehaviour?: RequestModeInput): Promise<string[]>;
+/**
+ * GraphQL query to retrieve all API versions.
+ *
+ * @param session - Shopify admin session including token and Store FQDN.
+ * @param preferredBehaviour - Custom request behaviour for retries and timeouts.
+ * @returns - An array of supported and unsupported API versions.
+ */
+export declare function fetchApiVersions(session: AdminSession, preferredBehaviour?: RequestModeInput): Promise<ApiVersion[]>;
 /**
  * Returns the Admin API URL for the given store and version.
  *
@@ -50,6 +58,10 @@ export declare function supportedApiVersions(session: AdminSession, preferredBeh
  * @returns - Admin API URL.
  */
 export declare function adminUrl(store: string, version: string | undefined, session?: AdminSession): string;
+interface ApiVersion {
+    handle: string;
+    supported: boolean;
+}
 /**
  * Executes a REST request against the Admin API.
  *
@@ -82,4 +94,5 @@ export interface RestResponse {
     headers: {
         [key: string]: string[];
     };
-}
\ No newline at end of file
+}
+export {};
\ No newline at end of file

nickwesselman mentioned this pull request Dec 9, 2025

Improve bulk operation polling with faster initial checks and hide zero counts #6695

Merged

3 tasks

nickwesselman marked this pull request as ready for review December 9, 2025 17:17

nickwesselman requested a review from a team as a code owner December 9, 2025 17:17

nickwesselman changed the title ~~Improve error messaging for failures on bulk operation creation~~ Use minimum API version for bulk operations Dec 9, 2025

nickwesselman requested review from ericlee878 and jordanverasamy December 9, 2025 19:53

jordanverasamy reviewed Dec 9, 2025

View reviewed changes

packages/app/src/cli/services/bulk-operations/bulk-operation-status.test.ts Outdated Show resolved Hide resolved

jordanverasamy approved these changes Dec 9, 2025

View reviewed changes

nickwesselman force-pushed the poll_bulk_operations_faster branch from a694179 to d894b0c Compare December 9, 2025 20:20

nickwesselman force-pushed the bulk_operation_error_message branch from 0fbeaaa to 687de29 Compare December 9, 2025 20:20

ericlee878 reviewed Dec 9, 2025

View reviewed changes

packages/app/src/cli/services/bulk-operations/execute-bulk-operation.test.ts Outdated Show resolved Hide resolved

nickwesselman force-pushed the poll_bulk_operations_faster branch from d894b0c to 544183d Compare December 10, 2025 14:14

nickwesselman requested a review from a team as a code owner December 10, 2025 14:14

nickwesselman force-pushed the bulk_operation_error_message branch from 847e0d3 to 8cffe52 Compare December 10, 2025 14:14

nickwesselman force-pushed the poll_bulk_operations_faster branch from 544183d to 9d4706e Compare December 10, 2025 16:10

nickwesselman force-pushed the bulk_operation_error_message branch from 8cffe52 to 28408ea Compare December 10, 2025 16:10

nickwesselman mentioned this pull request Dec 10, 2025

Add support for executing GraphQL queries on non-dev stores #6689

Closed

3 tasks

Base automatically changed from poll_bulk_operations_faster to main December 11, 2025 14:24

gonzaloriestra approved these changes Dec 12, 2025

View reviewed changes

packages/app/src/cli/services/graphql/common.ts Outdated Show resolved Hide resolved

packages/app/src/cli/services/graphql/common.ts Show resolved Hide resolved

nickwesselman force-pushed the bulk_operation_error_message branch from 28408ea to d3c6bcf Compare December 12, 2025 15:55

nickwesselman mentioned this pull request Dec 12, 2025

POC of adding header support to app execute #6716

Closed

3 tasks

nickwesselman added 6 commits December 12, 2025 15:00

Improve error messaging for failures on bulk operation creation

655f46b

refactor version validation to allow RCs and default to 2026-01 for b…

8d02b7a

…ulk operations

PR feedback on function signature

db481d2

better testing of resolveApiVersion use

2aeb596

PR feedback: Use constant for API version in tests

d2e908f

PR feedback: Added an options type for resolveApiVersion

b7caf67

nickwesselman force-pushed the bulk_operation_error_message branch from 29170fd to b7caf67 Compare December 12, 2025 20:17

nickwesselman added 2 commits December 12, 2025 15:19

remove unused export

efc420b

fix more instances of 2026-01

a96993e

nickwesselman added the #gsd:47715 label Dec 12, 2025 — with Graphite App

nickwesselman added this pull request to the merge queue Dec 12, 2025

Merged via the queue into main with commit aa19356 Dec 12, 2025
42 of 45 checks passed

nickwesselman deleted the bulk_operation_error_message branch December 12, 2025 21:08

Comments

Conversation

nickwesselman commented Dec 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

WHY are these changes introduced?

WHAT is this pull request doing?

How to test your changes?

Measuring impact

Checklist

Uh oh!

nickwesselman commented Dec 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 9, 2025

Uh oh!

github-actions bot commented Dec 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage report

Test suite run success

Uh oh!

Uh oh!

jordanverasamy left a comment

Choose a reason for hiding this comment

Uh oh!

nickwesselman commented Dec 9, 2025

Uh oh!

Uh oh!

nickwesselman commented Dec 9, 2025

Uh oh!

gonzaloriestra commented Dec 10, 2025

Uh oh!

gonzaloriestra commented Dec 10, 2025

Uh oh!

gonzaloriestra commented Dec 11, 2025

Uh oh!

gonzaloriestra commented Dec 12, 2025

Uh oh!

Uh oh!

Uh oh!

nickwesselman commented Dec 12, 2025

Uh oh!

github-actions bot commented Dec 12, 2025

Differences in type declarations

New type declarations

Existing type declarations

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

nickwesselman commented Dec 9, 2025 •

edited

Loading

nickwesselman commented Dec 9, 2025 •

edited

Loading

github-actions bot commented Dec 9, 2025 •

edited

Loading